Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4867

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Update README.md #4867

merged 1 commit into from
Sep 23, 2024

Conversation

gheber
Copy link
Member

@gheber gheber commented Sep 23, 2024

Clarify the different documentation flavors, and make the release documentation the first port of call.

Clarify the different documentation flavors, and make the release documentation the first port of call.

The latest doxygen documentation generated on changes to develop is available at:
The latest Doxygen documentation generated on changes to `develop`, which does **not** correspond to any particular library release, is available at:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it important to mention that documentation is Doxygen generated? Is this piece of information really important for users?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing wrong with giving credit to another OSS project.

@byrnHDF
Copy link
Contributor

byrnHDF commented Sep 23, 2024

Well the documentation is only updated when there are changes to the source, which trigger a build.

@gheber gheber merged commit 8926e4a into HDFGroup:develop Sep 23, 2024
2 checks passed
@gheber gheber deleted the update/2024-09-23 branch September 23, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants